home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / PDMakeMessage.z / PDMakeMessage
Text File  |  1998-10-30  |  3KB  |  67 lines
  1.  
  2.  
  3.  
  4. PPPPDDDDMMMMaaaakkkkeeeeMMMMeeeessssssssaaaaggggeeee((((3333))))                 IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo                  PPPPDDDDMMMMaaaakkkkeeeeMMMMeeeessssssssaaaaggggeeee((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      PDMakeMessage - message creation convenience function
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ppppoooodddd....hhhh>>>>
  13.  
  14.      iiiinnnntttt PPPPDDDDMMMMaaaakkkkeeeeMMMMeeeessssssssaaaaggggeeee((((PPPPDDDDMMMMeeeessssssssaaaaggggeeeeSSSSttttrrrruuuucccctttt ****mmmmeeeessssssssaaaaggggeeee,,,, iiiinnnntttt ccccooooddddeeee))));;;;
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      _P_D_M_a_k_e_M_e_s_s_a_g_e is a convenience function for filling a _P_D_M_e_s_s_a_g_e_S_t_r_u_c_t
  18.      structure. This function is useful when building an array of messages for
  19.      use with the _P_D_L_o_c_a_l_W_r_i_t_e_S_t_a_t_u_s function.
  20.  
  21.      _P_D_M_a_k_e_M_e_s_s_a_g_e fills the structure pointed to by _m_e_s_s_a_g_e with the message
  22.      code specified by _c_o_d_e. _c_o_d_e is one of the standard error, warning or
  23.      information codes defined in _p_o_d._h. The text field of the message
  24.      structure is automatically set to a standard message based on the value
  25.      of _c_o_d_e.
  26.  
  27.      The _P_D_M_e_s_s_a_g_e_S_t_r_u_c_t is defined as follows.
  28.  
  29.           typedef struct _pdMessageStruct {
  30.               int message_code;
  31.               char message_text[PD_STR_MAX];
  32.           } PDMessageStruct;
  33.  
  34.  
  35.      _m_e_s_s_a_g_e__c_o_d_e        Error, warning or information message code ID (see
  36.                          _p_o_d._h).
  37.  
  38.      _m_e_s_s_a_g_e__t_e_x_t        Text for the message truncated to a length of
  39.                          PD_STR_MAX-1.
  40.  
  41. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  42.      0 is returned if execution was successful. -1 is returned and _P_D_e_r_r_n_o is
  43.      set if an execution error has occurred.
  44.  
  45. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  46.      _P_D_M_a_k_e_M_e_s_s_a_g_e will fail under the following circumstances.
  47.  
  48.      PD_LIBERR_BAD_STRUCT     A NULL structure pointer has been specified.
  49.  
  50.      PD_LIBERR_BAD_MSG        An invalid message code has been specified.
  51.                               Valid message codes are listed in _p_o_d._h.
  52.  
  53. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  54.      PDReadStatus(3), libpod(3)
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.